Networking Objects

This chapter includes the various networking Inspectors.

tcp state

These inspectors expose the state of a socket on an endpoint

Creation Methods

Declaration	Description	Platforms (?)
tcp state of <socket>	Returns a <tcp state> of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0

Properties

Declaration	Return type	Description	Platforms (?)
<tcp state> as string	<string>	Cast a <tcp state> to a string representation	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
close wait of <tcp state>	<boolean> Plural: close waits	Returns true if the state represented is CLOSE_WAIT	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
closed of <tcp state>	<boolean> Plural: closeds	Returns true if the state represented is CLOSED	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
closing of <tcp state>	<boolean> Plural: closings	Returns true if the state represented is CLOSING	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
delete tcb of <tcp state>	<boolean> Plural: delete tcbs	Returns true if the state represented is DELETE_TCB	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
established of <tcp state>	<boolean> Plural: establisheds	Returns true if the state represented is ESTABLISHED	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
fin wait one of <tcp state>	<boolean> Plural: fin wait ones	Returns true if the state represented is FIN_WAIT1	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
fin wait two of <tcp state>	<boolean> Plural: fin wait twos	Returns true if the state represented is FIN_WAIT2	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
last ack of <tcp state>	<boolean> Plural: last acks	Returns true if the state represented is LAST_ACK	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
listening of <tcp state>	<boolean> Plural: listenings	Returns true if the state represented is LISTENING	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
syn received of <tcp state>	<boolean> Plural: syn receiveds	Returns true if the state represented is SYN_RECEIVED	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
syn sent of <tcp state>	<boolean> Plural: syn sents	Returns true if the state represented is SYN_SENT	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
time wait of <tcp state>	<boolean> Plural: time waits	Returns true if the state represented is TIME_WAIT	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0

socket

These inspectors expose the sockets opened on the network on the endpoint

Creation Methods

Declaration	Description	Platforms (?)
socket of <network>	Returns a <socket> type that is examinable for socket information.	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0

Properties

Declaration	Return type	Description	Platforms (?)
local address of <socket>	<ipv4or6 address> Plural: local addresses	Returns an <ipv4or6 address> representing the local address of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
local port of <socket>	<integer> Plural: local ports	Returns an <integer> representing the local port number of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
process of <socket>	<process> Plural: processes	Returns a <process> representing the local owner of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
remote address of <socket>	<ipv4or6 address> Plural: remote addresses	Returns a <ipv4or6 address> representing the remote address of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
remote port of <socket>	<integer> Plural: remote ports	Returns an <integer> representing the remote port number of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
tcp of <socket>	<boolean> Plural: tcps	Returns true if the socket is a TCP socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
tcp state of <socket>	<tcp state> Plural: tcp states	Returns a <tcp state> of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
udp of <socket>	<boolean> Plural: udps	Returns true if the socket is a UDP socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0

wifi

These inspectors expose the WiFi adapters available on an endpoint.

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

network

The <network> objects are the keywords used to query the local network configuration.

Creation Methods

Declaration	Description	Platforms (?)
network	Returns an object containing properties of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
socket of <network>	<socket> Plural: sockets	Returns a <socket> type that is examinable for socket information.	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
adapter of <network>	<network adapter> Plural: adapters	Returns the one or more network adapter objects of the network.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
any adapter of <network>	<network adapter> Plural: any adapters	This Inspector returns the same as 'adapter of <network>', but it includes loopback and tunnels.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
find adapter <string> of <network>	<network adapter> Plural: find adapters	This Inspector lets you find a network adapter from the "Friendly Name".	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
interface <integer> of <network>	<network interface> Plural: interfaces	Returns the Nth interface of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
interface of <network>	<network interface> Plural: interfaces	Returns all the interfaces of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ip interface <integer> of <network>	<network ip interface> Plural: ip interfaces	Returns the Nth ip interface of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ip interface of <network>	<network ip interface> Plural: ip interfaces	Returns all the ip interfaces of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ipv4 interface of <network>	<network adapter interface> Plural: ipv4 interfaces	Returns an IPv4 network adapter interface from the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4or6 interface of <network>	<network adapter interface> Plural: ipv4or6 interfaces	Returns all the ipv4or6 network adapter interfaces from the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv6 interface of <network>	<network adapter interface> Plural: ipv6 interfaces	Returns all the ipv6 interfaces of the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

network interface

The network interface object describes a generic network interface, and has information about the name and family of that interface. On the Mac these are commonly of type AF_INET, AF_LINK and AF_INET6.

Creation Methods

Declaration	Description	Platforms (?)
interface <integer> of <network>	Returns the Nth interface of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
interface of <network>	Returns all the interfaces of the network. Example: names of interfaces of network - Returns a list of the network interface names, for example, lo0, gif0, stf0, en0.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
family of <network interface>	<integer> Plural: families	Returns an family designator of the address family (i.e., 2=AFI_NET).	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

network ip interface

In general, the network ip interface object holds locally determined properties of logical network devices configured on the computer. On the Mac, these correspond to interfaces of type AF_INET. The properties that are available depend on the socket support installed on the computer. For Windows computers with winsock 2 support installed, for instance, the information is obtained by an ioctl call and includes Interface address, Interface broadcast address, Interface network mask, Broadcast support flag, Multicast support flag, Loopback interface flag and Point to point interface flag.

Creation Methods

Declaration	Description	Platforms (?)
ip interface <integer> of <network>	Returns the Nth ip interface of the network.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ip interface of <network>	Returns all the ip interfaces of the network. Example: names of ip interfaces of network - Returns a list of the names of the network IP interfaces, for example, lo0, en0. Example: addresses of ip interfaces of network - Returns a list of the IP addresses of the network IP interfaces, for example, 127.0.0.1, 192.168.1.100, etcetera.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
address of <network ip interface>	<ipv4 address> Plural: addresses	Returns the ip address of the ip interface.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
alias of <network ip interface>	<boolean> Plural: aliases	Returns TRUE if the network ip interface has an alias defined for it (a virtual device, rather than a physical device).	Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
broadcast address of <network ip interface>	<ipv4 address> Plural: broadcast addresses	Returns the broadcast address of the specified interface as an IPv4 type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
broadcast support of <network ip interface>	<boolean> Plural: broadcast supports	Indicates that broadcast messages are supported by the ip interface.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
cidr address of <network ip interface>	<string> Plural: cidr addresses	Returns the Classless Inter-Domain Routing address for the specified network ip interface as a string type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network ip interface>	<string> Plural: cidr strings	Returns the Classless Inter-Domain Routing value for the specified network ip interface as a string type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
loopback of <network ip interface>	<boolean> Plural: loopbacks	Indicates that the particular network ip interface is a loopback interface.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
mac address of <network ip interface>	<string> Plural: mac addresses	Returns the MAC address (AKA hardware address) of the network ip interface object. The mac address is formatted as a string of lower case hex digits separated by '-'.	Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
multicast support of <network ip interface>	<boolean> Plural: multicast supports	Indicates that multicast messages are supported by the ip interface.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <network ip interface>	<string> Plural: names	Returns the name of the network ip interface object. Typical names are lan0, lo0. Virtual interfaces are usually of the form lan0:2.	Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
point to point of <network ip interface>	<boolean> Plural: point to points	Indicates that the interface is a point-to-point interface. Usually TRUE for dialup connections.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subnet address of <network ip interface>	<ipv4 address> Plural: subnet addresses	Returns the subnet address (IPv4) to which the specified interface belongs.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subnet mask of <network ip interface>	<ipv4 address> Plural: subnet masks	Returns the subnet mask (IPv4) of the specified network ip interface.As of version 8.0, this Inspector type is derived from an <ipv4or6 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
up of <network ip interface>	<boolean> Plural: ups	Returns TRUE if the specified network IP interface is currently up.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

network link interface

The network link interface objects correspond to interfaces of type AF_LINK.

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

network share

network address list

A network adapter may be configured to respond to a list of network addresses. This object type provides access to such a list.

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

network adapter

One or more network adapters may be inspected using this property of the network object. Each network adapter has a number of interesting properties such as the MAC address.

Creation Methods

Declaration	Description	Platforms (?)
adapter of <network>	Returns the one or more network adapter objects of the network.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
any adapter of <network>	This Inspector returns the same as 'adapter of <network>', but it includes loopback and tunnels.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
find adapter <string> of <network>	This Inspector lets you find a network adapter from the "Friendly Name". Example: address of find adapter "Local Area Connection" of network - Returns an IP address corresponding to the Local Area Connection of the network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
adapter of <network adapter interface>	Returns the adapters associated with the specified network adapter interface.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
address of <network adapter>	<ipv4 address> Plural: addresses	Returns the ip address of the network adapter (returns the first address if it is a list).	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
cidr address of <network adapter>	<string> Plural: cidr addresses	Returns the CIDR address of the specified network adapter as a string type, for example, 192.168.0.0/16 (IPv4) or 2001:db8::/32 (IPv6).	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network adapter>	<string> Plural: cidr strings	Returns the Classless Inter-Domain Routing value for the specified network adapter as a string value.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
friendly name of <network adapter>	<string> Plural: friendly names	Returns a user-friendly name for the adapter, for example "Local Area Connection 1".	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
ipv4 interface of <network adapter>	<network adapter interface> Plural: ipv4 interfaces	Returns the IPv4 interface of the specified network adapter as a <network adapter ip interface> type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4or6 interface of <network adapter>	<network adapter interface> Plural: ipv4or6 interfaces	Returns the ipv4or network adapter interface from the specified network adapter.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv6 interface of <network adapter>	<network adapter interface> Plural: ipv6 interfaces	Returns the IPv6 interfaces of the specified network adapter as a network adapter interface type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
loopback of <network adapter>	<boolean> Plural: loopbacks	Returns TRUE if the specified network adapter is a loopback interface.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1
mac address of <network adapter>	<string> Plural: mac addresses	Returns the mac address of the network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
multicast support of <network adapter>	<boolean> Plural: multicast supports	Returns TRUE if multicast messages are supported by the specified network adapter.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1
name of <network adapter>	<string> Plural: names	Returns the name of the network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
subnet address of <network adapter>	<ipv4 address> Plural: subnet addresses	Returns the subnet address (IPv4) of the specified network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
subnet mask of <network adapter>	<ipv4 address> Plural: subnet masks	Returns the subnet mask (IPv4) of the specified network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
up of <network adapter>	<boolean> Plural: ups	Returns TRUE if the specified network adaoter is currently working. Interfaces like wifi may be turned it off to save power, but this Inspector will still tell you if it is active.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1

network adapter interface

A network adapter interfaces a computer to a network. These Inspectors expose the adapter so that you can determine its properties, such as its address, subnet mask, mac address and whether or not it supports broadcast, multicast or point-to-point.

Creation Methods

Declaration	Description	Platforms (?)
ipv4 interface of <network>	Returns an IPv4 network adapter interface from the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4or6 interface of <network>	Returns all the ipv4or6 network adapter interfaces from the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv6 interface of <network>	Returns all the ipv6 interfaces of the specified network.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4 interface of <network adapter>	Returns the IPv4 interface of the specified network adapter as a <network adapter ip interface> type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4or6 interface of <network adapter>	Returns the ipv4or network adapter interface from the specified network adapter.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv6 interface of <network adapter>	Returns the IPv6 interfaces of the specified network adapter as a network adapter interface type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
adapter of <network adapter interface>	<network adapter> Plural: adapters	Returns the adapters associated with the specified network adapter interface.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
address of <network adapter interface>	<ipv4or6 address> Plural: addresses	Returns the IP address of the specified network adapter interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
broadcast address of <network adapter interface>	<ipv4or6 address> Plural: broadcast addresses	Creates an object with the broadcast address (ipv4or6) of the specified network adapter interface.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
broadcast support of <network adapter interface>	<boolean> Plural: broadcast supports	Returns TRUE if the given network adapter interface has broadcast support.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr address of <network adapter interface>	<string> Plural: cidr addresses	Returns the CIDR address of the specified interface as a string type, for example, 192.168.0.0/16 (IPv4) or 2001:db8::/32 (IPv6).	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network adapter interface>	<string> Plural: cidr strings	A cidr string (see CIDR_notation at Wikipedia) is a string representation of a cidr address. It looks like an ip address followed by a slash and then the number of leading non-zero bits of the routing prefix. For example, 192.168.0.0/16 for IPv4, and 2001:db8::/32 for IPv6.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
loopback of <network adapter interface>	<boolean> Plural: loopbacks	Returns TRUE if the specified interface supports loopbacks.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
mac address of <network adapter interface>	<string> Plural: mac addresses	Returns the MAC address of the specified network adapter interface as a string type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
multicast support of <network adapter interface>	<boolean> Plural: multicast supports	Returns TRUE if the specified interface supports multicasting.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
point to point of <network adapter interface>	<boolean> Plural: point to points	A network adapter interface can be a point-to-point interface, such as you might use for a VPN connection or a SLIP connection. This Inspector returns TRUE if the specified network adapter interface is configured to run point-to-point.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
subnet address of <network adapter interface>	<ipv4or6 address> Plural: subnet addresses	Returns the subnet address of the specified interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
subnet mask of <network adapter interface>	<ipv4or6 address> Plural: subnet masks	Returns the subnet mask of the specified interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
up of <network adapter interface>	<boolean> Plural: ups	Returns TRUE if the specified interface is currently up and working.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

connection

The <connection> objects are used to query your connections. These are all properties of the Internet Connection Firewall, as returned in the NETCON_PROPERTIES structure.

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

connection status

The <connection status> objects return information about the status of your connections.

Creation Methods

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

internet protocol

Returns the firewall internet protocol corresponding to the Microsoft enumerated types, either tcp or udp. The Windows Firewall is supported on Windows XP SP2. For more information, search for 'Windows Firewall API' at the msdn site (http://msdn.microsoft.com/library/).

Creation Methods

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

ip version

The <ip version> Inspectors distinguish between ipv6 and ipv4. The integer representations of these are chosen to meet existing standards.

Creation Methods

Declaration	Description	Platforms (?)
any ip version	Returns a type corresponding to the Microsoft enumerated value NET_FW_IP_VERSION_ANY.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ip version <integer>	Returns the the IP version for the <integer> port corresponding to the Microsoft enumerated types:0: NET_FW_IP_VERSION_V41: NET_FW_IP_VERSION_V62: NET_FW_IP_VERSION_ANY3: NET_FW_IP_VERSION_MAX.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4	Provides a comparison value for a firewall or other ip version inspector.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv6	Provides a comparison value for a firewall or other ip version inspector.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ip version of <ipv4or6 address>	Returns the IP version of the specified ipv4or6 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Operators

Declaration	Return Type	Description	Platforms (?)
<ip version> = <ip version>	<boolean>	Compares two IP versions for equality.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
<ip version> as string	<string>	Converts an IP version to a string.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

ipv4 address

This is an Internet Protocol address, version 4. IP addresses are composed of four single-byte integers separated by periods, such as "192.5.0.7". Note: Prior to version 8.0 of BigFix, this was not a derived type.

Creation Methods

Declaration	Description	Platforms (?)
ipv4 address <string>	Returns an ipv4 address for the string provided. Example: ipv4 address "192.168.100.1" - Returns the four-byte ip address 192.168.100.1.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
address of <network ip interface>	Returns the ip address of the ip interface. Example: exists ip interface whose (address of it = "127.0.0.1" and loopback of it) of network - Returns TRUE if the specified ip interface (with loopback) exists on this computer. Example: addresses of ip interfaces of network - Returns a list of IP addresses configured on the machine.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
broadcast address of <network ip interface>	Returns the broadcast address of the specified interface as an IPv4 type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subnet address of <network ip interface>	Returns the subnet address (IPv4) to which the specified interface belongs.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subnet mask of <network ip interface>	Returns the subnet mask (IPv4) of the specified network ip interface.As of version 8.0, this Inspector type is derived from an <ipv4or6 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
address of <network adapter>	Returns the ip address of the network adapter (returns the first address if it is a list).	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
subnet address of <network adapter>	Returns the subnet address (IPv4) of the specified network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
subnet mask of <network adapter>	Returns the subnet mask (IPv4) of the specified network adapter.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
maximum of <ipv4 address>	Returns the maximum value from a list of <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <ipv4 address>	Returns the minimum value from a list of <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ipv4 part of <ipv6 address>	Returns the lowest 32-bits of the IPv6 address as an IPv4 address.As of version 8.0, this Inspector type is derived from an <ipv4or6 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ipv4 part of <ipv4or6 address>	Returns the lowest 32-bits of the IPv4or6 address as an IPv4 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
destination of <ipv4 route>	Returns an ipv4 address specifying the destination of the route.	Lin:8.2, Sol:8.2, Ubu:8.2
gateway of <ipv4 route>	Returns the ipv4 address of the route's gateway if the gateway flag is set, otherwise "0.0.0.0".	Lin:8.2, Sol:8.2, Ubu:8.2
mask of <ipv4 route>	Returns an ipv4 address containing the netmask of the route in the format "255.255.255.0".	Lin:8.2, Sol:8.2, Ubu:8.2

Operators

Declaration	Return Type	Description	Platforms (?)
<ipv4 address> {cmp} <ipv4 address>	<boolean>	Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .	Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <ipv4 address>	<boolean>	Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .	Win, Lin, Sol, HPUX, AIX, Mac, WM
<ipv4 address> {cmp} <string>	<boolean>	Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .	Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

Declaration	Return type	Description	Platforms (?)
<ipv4 address> as ipv4or6 address	<ipv4or6 address>	Converts an IPv4 address into the more inclusive ipv4or6 type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4 address> as ipv6 address	<ipv6 address>	Returns the specified IPv4 address embedded in a IPv6 address space as defined by RFC 4291 section 2.5.5.2: IPv4-Mapped IPv6 Address. In this scheme the lowest 32 bits of the IPv6 address contain the IPv4 address, the next higher 16 bits are all 1 (ffff) and the remaining bits are all 0.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv4 address> as string	<string>	Converts the ipv4 address to a string.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <ipv4 address>	<( ipv4 address, ipv4 address )> Plural: extremas	Returns the minimum and maximum extreme values of the given list of <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <ipv4 address>	<ipv4 address> Plural: maxima	Returns the maximum value from a list of <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <ipv4 address>	<ipv4 address> Plural: minima	Returns the minimum value from a list of <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <ipv4 address>	<ipv4 address with multiplicity> Plural: unique values	Returns the unique values of a given list of <ipv4 address> types, removing duplicates and sorting by value.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

ipv4 address with multiplicity

The <ipv4 address with multiplicity> Inspectors deal with ipv4 address arrays, allowing you to extract unique ipv4 addresses and count them.

Creation Methods

Declaration	Description	Platforms (?)
unique value of <ipv4 address>	Returns the unique values of a given list of <ipv4 address> types, removing duplicates and sorting by value.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <ipv4 address with multiplicity>	<integer> Plural: multiplicities	Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <ipv4 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

ipv6 address

The <ipv6 address> Inspectors deal with the Internet Protocol addressing scheme, version 6. Note: Prior to version 8.0 of BigFix, this was not a derived type.

Creation Methods

Declaration	Description	Platforms (?)
<string> as ipv6 address	Converts a string representations of an IPv6 address (with colons and/or dots) as an IPv6 address type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ipv6 address <string>	Converts a string representations of an IPv6 address (with colons and/or dots) into an IPv6 address type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv4 address> as ipv6 address	Returns the specified IPv4 address embedded in a IPv6 address space as defined by RFC 4291 section 2.5.5.2: IPv4-Mapped IPv6 Address. In this scheme the lowest 32 bits of the IPv6 address contain the IPv4 address, the next higher 16 bits are all 1 (ffff) and the remaining bits are all 0.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <ipv6 address>	Returns the maximum value from a list of <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <ipv6 address>	Returns the minimum value from a list of <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

Declaration	Return Type	Description	Platforms (?)
<ipv6 address> {cmp} <ipv6 address>	<boolean>	Where {cmp} is one of: <, <=, =.	Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

Declaration	Return type	Description	Platforms (?)
<ipv6 address> as compressed string	<string>	Similar to casting as a string, but with double colons used to represent multiple zero 16-bit parts (RFC 4291 section 2.2, item 2).	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as compressed string with ipv4	<string>	Similar to casting as a string, but with both colon-compression and standard IPv4 representation for the low 32-bits.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as compressed string with ipv4 with zone index	<string>	Similar to casting as a string, but with both colon-compression and standard IPv4 representation for the low 32-bits as well as any zone index.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as compressed string with zone index	<string>	Similar to casting as a string, but with both colon-compression and a zone index.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as ipv4or6 address	<ipv4or6 address>	Casts an IPv6 address as a more flexible ipv4or6 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as string	<string>	Returns a string representation of the IPv6 address in the form x:x:x:x:x:x:x:x, where each x represents one to four hexadecimal digits of the eight 16-bit address fields. Leading zeros in an individual field are omitted. See RFC 4291 section 2.2, item 1.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with ipv4	<string>	Similar to casting as a string, but with the lowest 32 bits of the address in the standard IPv4 representation (RFC 4291 section 2.2, item 3).	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with ipv4 with zone index	<string>	Similar to casting as a string, but with standard IPv4 representation for the low 32-bits as well as any zone index.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as string with leading zeros	<string>	Similar to casting as a string, but leading zeros in individual fields are preserved.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with leading zeros with zone index	<string>	Converts an IPv6 address into a string with all fields packed with leading zeroes as well as a terminating zone index, if any.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as string with zone index	<string>	Converts an IPv6 address into a string with a terminating slash-delimited zone index, if any.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
extrema of <ipv6 address>	<( ipv6 address, ipv6 address )> Plural: extremas	Returns the minimum and maximum extreme values of the given list of <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hexadecet <integer> of <ipv6 address>	<integer> Plural: hexadecets	Returns one of the eight 16-bit parts (hexadecets) of an IPv6 address specified by <integer>. Here zero refers to the highest hexadecet (network or big-endian order). Thus hexadecet 0 refers to the most-significant 16-bits of the 128 bit IPv6 address.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ipv4 part of <ipv6 address>	<ipv4 address> Plural: ipv4 parts	Returns the lowest 32-bits of the IPv6 address as an IPv4 address.As of version 8.0, this Inspector type is derived from an <ipv4or6 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <ipv6 address>	<ipv6 address> Plural: maxima	Returns the maximum value from a list of <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <ipv6 address>	<ipv6 address> Plural: minima	Returns the minimum value from a list of <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <ipv6 address>	<ipv6 address with multiplicity> Plural: unique values	Returns the unique values of a given list of <ipv6 address> types, removing duplicates and sorting by value.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

ipv6 address with multiplicity

The <ipv6 address with multiplicity> Inspectors deal with ipv6 address arrays, allowing you to extract unique ipv6 addresses and count them.

Creation Methods

Declaration	Description	Platforms (?)
unique value of <ipv6 address>	Returns the unique values of a given list of <ipv6 address> types, removing duplicates and sorting by value.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <ipv6 address with multiplicity>	<integer> Plural: multiplicities	Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <ipv6 address> types.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

ipv4or6 address

The <ipv4or6 address> Inspectors allow you to represent IPv4 and IPv6 addresses as a common type. From these inclusive Inspectors, you can derive the corresponding v4 and v6 IP addresses.

Creation Methods

Declaration	Description	Platforms (?)
<string> as ipv4or6 address	Converts a string version of an IP address into the flexible ipv4or6 address format.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4or6 address <string>	Returns an ipv4or6 address object as described by the given string.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
registration address of <client>	This Inspector returns the IP address (as an <ipv4or6 address> type) that the specified BigFix client registered with.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
registration subnet address of <client>	This Inspector returns the subnet address (as an <ipv4or6 address> type) from the adapter that the specified BigFix client registered with.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
full gateway address of <selected server>	During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. That list is accessible through this Inspector. Unlike the 'gateway address' Inspector, this Inspector includes hops that don't reply as 0.0.0.0.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
gateway address <integer> of <selected server>	During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. The elements of that list is accessible through this Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gateway address of <selected server>	During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. That list is accessible through this Inspector. However, this Inspector ignores hops that don't reply. If you need the full list, use the 'full gateway address' Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ip address of <selected server>	The ipv4or6 address to which reports are sent.Prior to version 8.0, this inspector returned an <ipv4 address> type.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
local address of <socket>	Returns an <ipv4or6 address> representing the local address of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
remote address of <socket>	Returns a <ipv4or6 address> representing the remote address of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
address of <network adapter interface>	Returns the IP address of the specified network adapter interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
broadcast address of <network adapter interface>	Creates an object with the broadcast address (ipv4or6) of the specified network adapter interface.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
subnet address of <network adapter interface>	Returns the subnet address of the specified interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
subnet mask of <network adapter interface>	Returns the subnet mask of the specified interface as an ipv4or6 address type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4 address> as ipv4or6 address	Converts an IPv4 address into the more inclusive ipv4or6 type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as ipv4or6 address	Casts an IPv6 address as a more flexible ipv4or6 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
maximum of <ipv4or6 address>	Returns the maximum of the specified list of <ipv4or6 address> types.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
minimum of <ipv4or6 address>	Returns the minimum of the specified list of <ipv4or6 address> types.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Operators

Declaration	Return Type	Description	Platforms (?)
<ipv4or6 address> {cmp} <ipv4or6 address>	<boolean>	Where {cmp} is one of: <, <=, =.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0
<ipv4or6 address> {cmp} <string>	<boolean>	Where {cmp} is one of: <, <=, =.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0
<string> {cmp} <ipv4or6 address>	<boolean>	Where {cmp} is one of: <, <=, =.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0

Properties

Declaration	Return type	Description	Platforms (?)
<ipv4or6 address> as compressed string	<string>	Compresses the IP address, using double colons to stand in for repeated zeroes in the address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with ipv4	<string>	Similar to casting to a string, but with both colon-compression and standard IPv4 representation for the low 32-bits.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with ipv4 with zone index	<string>	Creates a compressed string (replacing multiple zeroes with double colons) with the lower 32 bits in IPv4 format. It includes the zone index (on Windows, typically a number) following a percent sign (%).	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with zone index	<string>	Creates a compressed string (replacing multiple zeroes with double colons) and includes the zone index (on Windows, typically a number) following a percent sign (%).	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string	<string>	Casts an IP address (v4 or 6) as a string type.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with ipv4	<string>	Converts an address to a string with the lower 32 bits in IPv4 format.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with ipv4 with zone index	<string>	Converts an address to a string with the lower 32 bits in IPv4 format as well as any zone index.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with leading zeros	<string>	Converts an IP address into a string with all fields packed with leading zeroes.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with leading zeros with zone index	<string>	Converts an IP address into a string with all fields packed with leading zeroes, as well as any zone index.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with zone index	<string>	Converts an IP address into a string with a zone index, if any.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
extrema of <ipv4or6 address>	<( ipv4or6 address, ipv4or6 address )> Plural: extremas	Returns the minimum and maximum of the specified list of ipv4or6 addresses.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
hexadecet <integer> of <ipv4or6 address>	<integer> Plural: hexadecets	Returns one of the eight 16-bit parts (hexadecets) of an ipv4or6 address specified by <integer>. Here zero refers to the highest hexadecet (network or big-endian order). Thus hexadecet 0 refers to the most-significant 16-bits of the 128 bit ipv4or6 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ip version of <ipv4or6 address>	<ip version> Plural: ip versions	Returns the IP version of the specified ipv4or6 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ipv4 part of <ipv4or6 address>	<ipv4 address> Plural: ipv4 parts	Returns the lowest 32-bits of the IPv4or6 address as an IPv4 address.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
maximum of <ipv4or6 address>	<ipv4or6 address> Plural: maxima	Returns the maximum of the specified list of <ipv4or6 address> types.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
minimum of <ipv4or6 address>	<ipv4or6 address> Plural: minima	Returns the minimum of the specified list of <ipv4or6 address> types.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
unique value of <ipv4or6 address>	<ipv4or6 address with multiplicity> Plural: unique values	Returns the unique values of a given list of addresses (ipv4or6), removing duplicates and sorting by value.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

ipv4or6 address with multiplicity

The <ipv4or6 address with multiplicity> Inspectors deal with arrays of ipv4or6 addresses, allowing you to extract unique addresses and count them.

Creation Methods

Declaration	Description	Platforms (?)
unique value of <ipv4or6 address>	Returns the unique values of a given list of addresses (ipv4or6), removing duplicates and sorting by value.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <ipv4or6 address with multiplicity>	<integer> Plural: multiplicities	Returns the multiplicity (how many entries of each unique address) of a list of ipv4or6 addresses.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

ipv4 route

Creation Methods

Declaration	Description	Platforms (?)
route of <ipv4 routing table>	Returns all the routes in the routing table in Linux. On Solaris, this returns all routes which are not broadcast, local, or cache routes.	Lin:8.2, Sol:8.2, Ubu:8.2

Properties

Declaration	Return type	Description	Platforms (?)
destination of <ipv4 route>	<ipv4 address>	Returns an ipv4 address specifying the destination of the route.	Lin:8.2, Sol:8.2, Ubu:8.2
gateway flag of <ipv4 route>	<boolean>	Returns a boolean specifying if the route is going through a gateway.	Lin:8.2, Sol:8.2, Ubu:8.2
gateway of <ipv4 route>	<ipv4 address>	Returns the ipv4 address of the route's gateway if the gateway flag is set, otherwise "0.0.0.0".	Lin:8.2, Sol:8.2, Ubu:8.2
host flag of <ipv4 route>	<boolean>	Returns a boolean specifying if the target of the route is a host.	Lin:8.2, Sol:8.2, Ubu:8.2
interface of <ipv4 route>	<string>	Returns a string containing the name of the interface the route goes through.	Lin:8.2, Sol:8.2, Ubu:8.2
irtt of <ipv4 route>	<integer>	Returns an integer specifying the initial roud trip time for TCP connections over the route in milliseconds (1-12000). Typically only used on AX.25 networks, with a default value of 300 if not specified.	,
mask of <ipv4 route>	<ipv4 address>	Returns an ipv4 address containing the netmask of the route in the format "255.255.255.0".	Lin:8.2, Sol:8.2, Ubu:8.2
metric of <ipv4 route>	<integer>	Returns an integer specifying the metric value of the route.	,
mtu of <ipv4 route>	<integer>	Returns an integer specifying the maximum transmission unit setting of the route. Typically not used.	,
reject flag of <ipv4 route>	<boolean>	Returns a boolean specifying if the route is a blocking route.	Lin:8.2, Sol:8.2, Ubu:8.2
up flag of <ipv4 route>	<boolean>	Returns a boolean specifying if the route is up.	Lin:8.2, Sol:8.2, Ubu:8.2
window of <ipv4 route>	<integer>	Returns the TCP window setting for connections over the route. Typically only used on AX.25 networks and with drivers unable to handle back to back frames.	,

ipv4 routing table

Creation Methods

Declaration	Description	Platforms (?)
ipv4 routing table	Returns the ipv4 routing table. Use 'routes of ipv4 routing table' or 'all routes of ipv4 routing table' to get more information.	Lin:8.2, Sol:8.2, Ubu:8.2

Properties

Declaration	Return type	Description	Platforms (?)
route of <ipv4 routing table>	<ipv4 route>	Returns all the routes in the routing table in Linux. On Solaris, this returns all routes which are not broadcast, local, or cache routes.	Lin:8.2, Sol:8.2, Ubu:8.2

Terminology

Platform

Contents